<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.rays.Rays</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        <a href="py2ecotect.doc.rays-module.html">Module&nbsp;rays</a> ::
        Class&nbsp;Rays
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.rays.Rays-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Rays</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Rays</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#animate" class="summary-sig-name">animate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Begins the ray animation from the current position of the animation 
      frame counter.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.animate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#free" class="summary-sig-name">free</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Clears any existing rays or particles from the model and frees 
      associated application memory.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.free">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#generate" class="summary-sig-name">generate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">method</span>)</span><br />
      Sprays rays from the currently defined source point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.generate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#rewind" class="summary-sig-name">rewind</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Rewinds the ray animation frame counter back to the beginning.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.rewind">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Saves the currently displayed rays or particles to an ECOTECT Ray 
      (.ray) file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#step" class="summary-sig-name">step</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">steps</span>)</span><br />
      Steps the ray animation frame counter forward by the number of steps 
      specified.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.step">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Recalculates ray point values.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#get_avg_absorption" class="summary-sig-name">get_avg_absorption</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">band</span>)</span><br />
      Retrieves the average absorption co-efficient of all incident rays at
      the given frequency band.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_avg_absorption">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#get_flag" class="summary-sig-name">get_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>)</span><br />
      Retrieves the current state of the specified flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#set_flag" class="summary-sig-name">set_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets the options for how ECOTECT displays ray objects in both the 
      view and opengl canvases.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.set_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#get_scale" class="summary-sig-name">get_scale</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the current set values of min and max.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.rays.Rays-class.html#set_scale" class="summary-sig-name">set_scale</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">min</span>,
        <span class="summary-sig-arg">max</span>,
        <span class="summary-sig-arg">inc</span>)</span><br />
      Sets the values of min and max.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.set_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#altitude" class="summary-name">altitude</a><br />
      Retrieves the controlling altitude angle when using the spherical or 
      cylindrical methods in the rays.spray command.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#angle" class="summary-name">angle</a><br />
      Retrieves the angular increment between rays when using the spherical
      or cylindrical methods in the rays.spray command.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#azimuth" class="summary-name">azimuth</a><br />
      Retrieves the controlling azimuth angle when using the spherical or 
      cylindrical methods in the rays.spray command.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#count" class="summary-name">count</a><br />
      Retrieves the number of rays in the ray list.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#distance" class="summary-name">distance</a><br />
      Retrieves the distance on which the animation is based.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#edt10" class="summary-name">edt10</a><br />
      Retrieves the Reverberation Time over 60dB taken from the 
      line-of-best fit of all currently stored acoustic rays.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#increment" class="summary-name">increment</a><br />
      Retrieves the animation frame increment in milliseconds.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#max_distance" class="summary-name">max_distance</a><br />
      Retrieves the maximum distance travelled by the longest ray.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#mean_free_path_length" class="summary-name">mean_free_path_length</a><br />
      Retrieves the average travel distance between striking surfaces, 
      averaged over all traced rays.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#nodes" class="summary-name">nodes</a><br />
      Retrieves the number of ray nodes in the ray list.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#precision" class="summary-name">precision</a><br />
      Retrieves the distance between points when rays are generated towards
      tagged acoustic reflectors using the reflectors method in the 
      rays.spray command.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#random" class="summary-name">random</a><br />
      Retrieves the currently set number of random rays to be generated 
      when the random method is used in the rays.spray command.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#reflections" class="summary-name">reflections</a><br />
      Retrieves the currently set maximum number of refections to test 
      during any subsequent ray spraying calculation.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#rt60" class="summary-name">rt60</a><br />
      Retrieves the value of the currently set Reverberation Time o ver 
      60dB taken from the line-of-best fit of all currently stored acoustic
      rays.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#source" class="summary-name">source</a><br />
      Retrieves the zero-based index number of the SPEAKER object currently
      being used as the sound source.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.rays.Rays-class.html#units" class="summary-name">units</a><br />
      Retrieves the units currently being used for each ray.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="animate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">animate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.animate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Begins the ray animation from the current position of the animation 
  frame counter.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="free"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">free</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.free">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Clears any existing rays or particles from the model and frees 
  associated application memory.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="generate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">generate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">method</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.generate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sprays rays from the currently defined source point.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>method The method used to spray as specified in the following Ray 
  Spray Methods table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Ray Spray Methods Token Value Description reflectors 0 Spray rays only
  at objects tagged as an acoustic reflector. random 1 Spray rays in random
  directions. spherical 2 Spray evenly distributed rays spherically. 
  cylindrical 3 Spray a circle of rays in one plane.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rewind"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rewind</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.rewind">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rewinds the ray animation frame counter back to the beginning.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Saves the currently displayed rays or particles to an ECOTECT Ray 
  (.ray) file.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The full path to where the ECOTECT Ray (.ray) file will be 
  stored.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="step"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">step</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">steps</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.step">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Steps the ray animation frame counter forward by the number of steps 
  specified.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>steps An integer representing the number of steps to move the counter 
  forward.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Recalculates ray point values. Use this command when a material is 
  changed or values need updating.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_avg_absorption"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_avg_absorption</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">band</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_avg_absorption">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the average absorption co-efficient of all incident rays at 
  the given frequency band.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>band An index of the frequency corresponding to the following Centre 
  Frequencies table.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>avgabs A decimal value containing the average absorption 
  co-efficient.</p>
  <p>Relevant Data Table(s)</p>
  <p>Octave Frequencies Value Frequency 0 63 Hz 1 125 Hz 2 250 Hz 3 500 Hz 
  4 1000 Hz 5 2000 Hz 6 4000 Hz 7 8000 Hz 8 16000 Hz</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current state of the specified flag. These properties 
  control how ECOTECT displays ray objects in both the view and opengl 
  canvases.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value or token corresponding to the following Rays 
  Flag Codes table.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value with the current state of the flag. This is a 
  boolean value where 1 is set and 0 means unset.</p>
  <p>Relevant Data Table(s)</p>
  <p>Rays Flag Codes Token Value Description rotate 1 Display rays while 
  rotating model. testonly 2 Test only acoustic reflectors when generating 
  rays. show 4 Display rays or particles within the model. numeric 8 
  Display sound levels as text for each ray. relative 16 Colour rays by 
  relative sound level. depth 128 Colour rays by reflection depth. hide 256
  Hide rays below specified sound level. fat 512 Show particles using fat 
  pixels. arrows 1024 Show rays as arrows. wheel 2048 Control ray animation
  using mouse wheel.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.set_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the options for how ECOTECT displays ray objects in both the view
  and opengl canvases.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value or token corresponding to the following Rays 
  Flag Codes table.</p>
  <p>[state] This optional parameter specifies whether to set the specified
  flag or not. This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative. If not given, this parameter 
  defaults to true if not specified.</p>
  <p>Relevant Data Table(s)</p>
  <p>Rays Falg Codes Token Value Description rotate 1 Display rays while 
  rotating model. testonly 2 Test only acoustic reflectors when generating 
  rays. show 4 Display rays or particles within the model. numeric 8 
  Display sound levels as text for each ray. relative 16 Colour rays by 
  relative sound level. depth 128 Colour rays by reflection depth. hide 256
  Hide rays below specified sound level. fat 512 Show particles using fat 
  pixels. arrows 1024 Show rays as arrows. wheel 2048 Control ray animation
  using mouse wheel.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_scale</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.get_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current set values of min and max. These refer to the 
  values used to colour each ray or point and is displayed in the legend. 
  The range is from min to max, where a point with a value less than or 
  equal to min will be displayed with the lowest colour, interpolated up 
  through to max where the highest colour is used.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>min The minimum value in the rays legend scale.</p>
  <p>max The maximum value in the rays legend scale.</p>
  <p>inc A decimal value containing the scale increment</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_scale</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">min</span>,
        <span class="sig-arg">max</span>,
        <span class="sig-arg">inc</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.rays-pysrc.html#Rays.set_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the values of min and max. These refer to the values used to 
  colour each ray or point and is displayed in the legend. The range is 
  from min to max, where a point with a value less than or equal to min 
  will be displayed with the lowest colour, interpolated up through to max 
  where the highest colour is used.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>min A decimal value representing the minimum value to use.</p>
  <p>max A decimal value representing the maximum value to use.</p>
  <p>inc A decimal value representing the scale increment.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="altitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">altitude</h3>
  <p>Retrieves the controlling altitude angle when using the spherical or 
  cylindrical methods in the rays.spray command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>alt The altitude in degrees.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the controlling altitude angle when using the spherical or 
cylindrical methods in the rays.spray command.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">angle</span>)</span>
        - Sets the controlling altitude angle when using the spherical or cylindrical
methods in the rays.spray command.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="angle"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">angle</h3>
  <p>Retrieves the angular increment between rays when using the spherical 
  or cylindrical methods in the rays.spray command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>angle The angular increment in degrees.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the angular increment between rays when using the spherical or 
cylindrical methods in the rays.spray command.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">angle</span>)</span>
        - Sets the angular increment between rays when using the spherical or 
cylindrical methods in the rays.spray command.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="azimuth"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">azimuth</h3>
  <p>Retrieves the controlling azimuth angle when using the spherical or 
  cylindrical methods in the rays.spray command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>azi The azimuth in degrees.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the controlling azimuth angle when using the spherical or 
cylindrical methods in the rays.spray command.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">angle</span>)</span>
        - Sets the controlling azimuth angle when using the spherical or cylindrical 
methods in the rays.spray command.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">count</h3>
  <p>Retrieves the number of rays in the ray list.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The number of rays in the ray list.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the number of rays in the ray list.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="distance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">distance</h3>
  <p>Retrieves the distance on which the animation is based. It is possible
  to use this to find the travel distance of the longest ray.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dist A decimal value containing the distance.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the distance on which the animation is based.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dist</span>)</span>
        - Sets the distance on which the animation is based.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="edt10"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">edt10</h3>
  <p>Retrieves the Reverberation Time over 60dB taken from the line-of-best
  fit of all currently stored acoustic rays. Note that this value is only 
  set during a calculation - see calc.acousticresponse for more 
  information.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>edt10 A decimal value containing the early decay time in seconds.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the Reverberation Time over 60dB taken from the line-of-best fit 
of all currently stored acoustic rays.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="increment"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">increment</h3>
  <p>Retrieves the animation frame increment in milliseconds.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>inc The current increment in milliseconds.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the animation frame increment in milliseconds.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">inc</span>)</span>
        - Sets the animation frame increment in milliseconds.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="max_distance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">max_distance</h3>
  <p>Retrieves the maximum distance travelled by the longest ray. This is 
  useful to know when changing the rays.distance property.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>distance The maximum distance travelled.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the maximum distance travelled by the longest ray.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="mean_free_path_length"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">mean_free_path_length</h3>
  <p>Retrieves the average travel distance between striking surfaces, 
  averaged over all traced rays. Note that this value is only set during a 
  calculation - see calc.acousticresponse for more information.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>length A decimal value containing the mean free path length.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the average travel distance between striking surfaces, averaged 
over all traced rays.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="nodes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">nodes</h3>
  <p>Retrieves the number of ray nodes in the ray list.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The number of ray nodes in the ray list.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the number of ray nodes in the ray list.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="precision"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">precision</h3>
  <p>Retrieves the distance between points when rays are generated towards 
  tagged acoustic reflectors using the reflectors method in the rays.spray 
  command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>precision A decimal value containing the distance.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the distance between points when rays are generated towards 
tagged acoustic reflectors using the reflectors method in the rays.spray 
command.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">precision</span>)</span>
        - Sets the currently set distance between points when rays are generated 
towards tagged acoustic reflectors using the reflectors method in the 
rays.spray command.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="random"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">random</h3>
  <p>Retrieves the currently set number of random rays to be generated when
  the random method is used in the rays.spray command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>rays An integer value respresenting the number of rays generated.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the currently set number of random rays to be generated when the 
random method is used in the rays.spray command.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">rays</span>)</span>
        - Sets the currently set number of random rays to be generated when the 
random method is used in the rays.spray command.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="reflections"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">reflections</h3>
  <p>Retrieves the currently set maximum number of refections to test 
  during any subsequent ray spraying calculation.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>bounces The maximum number of reflections.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the currently set maximum number of refections to test during any
subsequent ray spraying calculation.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>)</span>
        - Sets the currently set maximum number of refections to test during any 
subsequent ray spraying calculation.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="rt60"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">rt60</h3>
  <p>Retrieves the value of the currently set Reverberation Time o ver 60dB
  taken from the line-of-best fit of all currently stored acoustic rays. 
  Note that this value is only set during a calculation - see 
  calc.acousticresponse for more information.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>rt60 A decimal value containing the reverberation time in seconds.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the value of the currently set Reverberation Time o ver 60dB 
taken from the line-of-best fit of all currently stored acoustic rays.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="source"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">source</h3>
  <p>Retrieves the zero-based index number of the SPEAKER object currently 
  being used as the sound source.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index number of the SPEAKER object to be 
  used.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the zero-based index number of the SPEAKER object currently being
used as the sound source.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">speaker_object</span>)</span>
        - Sets the the SPEAKER object to be used as the sound source.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="units"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">units</h3>
  <p>Retrieves the units currently being used for each ray. This value is 
  also displayed at the top of the legend.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>units An text string representing the units to use.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the units currently being used for each ray.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">units</span>)</span>
        - Sets the units used for each ray.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
